快速入门指南
01. 开放平台整体介绍
本文档是开放平台的知识文档,将系统介绍开放平台能力以及调用方式。
通过开放平台,开发者可以基于DeBox开放能力,将自己的业务融入,产出商业化应用。
下面我们逐步、渐进式介绍开放平台能做什么、以及怎么做。
02. 开放平台能做什么?
2.1、小程序
开发者要知道的最重要的事是,DeBox支持小程序开发,开发者可以通过小程序将自己的任何合法业务接入到DeBox;
DeBox小程序是基于手机内置浏览器实现,所以支持HTML规范,开发者可以用HTML/JS构建任何界面、实现任何业务。
因为小程序的开放,第三方业务基本都能迁移到DeBox上。
参考文档 https://docs.debox.pro/zh/DAPP
2.2、登录授权
有了上面小程序,开发者可以开发出任何H5应用。
如果需要和DeBox用户系统打通,则需要用到登录授权功能,DeBox登录授权是基于author2.0标准协议,
参考如下文档,可以实现DeBox用户授权后即可登录第三方业务系统。
https://docs.debox.pro/zh/APIs/Authorized%20Login
2.3、vDBX积分支付
积分作为DeBox生态中的价值承载,参与到了各个环节的激励中。获得积分成为大家的共同爱好,如何获得积分
也成为了大家关系的话题。
DeBox把积分支付能力开放,推动积分流转,开发者通过给用户提供服务,赚取积分,比如电商、只是付费等。
积分支付文档 https://docs.debox.pro/zh/APIs/Authorized%20Payment
2.4、信息查询
以下信息可供开发者查询:
用户 文档参考 https://docs.debox.pro/zh/APIs/User%20Information
社区 文档参考 https://docs.debox.pro/zh/APIs/Community
动态 文档参考 https://docs.debox.pro/zh/APIs/Moment
红包 文档参考 https://docs.debox.pro/zh/APIs/LuckyBox
投票 文档参考 https://docs.debox.pro/zh/APIs/Vote%20&%20Giveaway
2.5、消息推送
开发者可以使用消息推送服务,将信息推送给粉丝、社区,给用户提供信息流、知识、广告。
相关文档参考 https://docs.debox.pro/zh/APIs/Sending%20Messages
2.6、指令机器人服务
除了小程序外,指令机器人是开发者和用户互动的最重要方式。通过指令,开发者向
用户提供服务。通过推拉两种方式将服务送达给用户。
推:开发者根据消息推送API定时、不定时、按一定规则把服务推送给用户;
拉:用户通过指令 / 访问机器人的指令,从而获得对应服务。
开发者下发的服务内容,可以带有链接,跳进自己的小程序,完成更复杂交互。
参考文档:https://docs.debox.pro/zh/Robot%20Guide
2.7、区块链Web3js相关
浏览器能做的,DeBox小程序都能做。此外,DeBox还向浏览器中注入了区块链的一些对象,
比如window.ethereum,开发者可以直接使用,完成与区块链的交互,比如区块链查询、
DeBox钱包授权、钱包签名、转账交易等等。
相关文档参考:https://docs.debox.pro/zh/APIs/BlockChain%20Transaction
03. 如何成为开发者?
注册开放平台,https://developer.debox.pro
可以用有Email注册登录,此时进入系统后应绑定DeBox钱包地址;
可以用DeBox钱包授权注册登录,此时进入系统应绑定Email;
配置基本信息
App Logo 、App Name 、Email、 Wallet Address
完成以上信息后,即可申请App Key、App Secret
有了App Key后,便可调用API接口
有了App Secret,便可调用支付类API
进行应用用户等级认证,获取API访问权限。
Level One: 开发者将获得除支付以外的所有API接口访问权限
Level Two: 开发者将拥有包括支付类API的访问权限
参考文档: https://docs.debox.pro/zh/KYC
完成以上步骤,开发者便获得了Api Key 以及API的访问权限。便可将开放平台的能力融入 到自己系统。
04. 如何调用API接口?
开放平台提供https协议的接口,任何语言都可以调用。
具体上行、下行参数,请参考对应接口文档。
消息推送示例,通过以下curl命令,将完成对消息推送API的调用,发送一条群消息。
注意:请把X-API-KEY换成自己的API KEY,把group_id换成自己的测 试群。
curl -X POST -H "Content-Type: application/json" -H "X-API-KEY: t2XJ........lEF6" -d '{"group_id":"l3ixp32y","object_name":"RCD:Graphic","title":"我是标题","content":"i am 富文本 {\"uitag\":\"a\",\"text\":\"点击我\",\"href\":\"https://debox.pro/\"}将跳转"}' "https://open.debox.pro/openapi/send_robot_group_message"
05. Go Sdk
提供了简单go语言的demo,参考 https://docs.debox.pro/zh/GO-SDK
06. 技术支持群
有任何问题,可以加入如下DeBox开发者社区群进行咨询讨论
技术支持群:https://m.debox.pro/group?id=660wp73h
07. 技术开发者支持客服
如有问题,还可添加客服DeBox账号,进行咨询:
客服账号:0xCba3fCE9D49CE5D7870443f324A8DD56A5788bfc